Node / public / reticulum / files / docs / source / gettingstartedfast.rst

Displaying Raw • Download

Tc9d1d9********************

Tc9d1d9Getting Started Fast

Tc9d1d9********************

The best way to get started with the Reticulum Network Stack depends on what

you want to do. This guide will outline sensible starting paths for different

scenarios.

Tc9d1d9Try Using a Reticulum-based Program

Tc9d1d9=============================================

If you simply want to try using a program built with Reticulum, you can take

a look at Ta5d6ff`Nomad Network Tffd700<https://github.com/markqvist/nomadnet>Ta5d6ff`_, which

provides a basic encrypted communications suite built completely on Reticulum.

Tb4b4b4.. Tff7b72imageTb4b4b4:: screenshots/nomadnet3.png

T56d364:target: _images/nomadnet3.png

Ta5d6ff`Nomad Network Tffd700<https://github.com/markqvist/nomadnet>Ta5d6ff`_ is a user-facing client

in the development for the messaging and information-sharing protocol

Ta5d6ff`LXMF Tffd700<https://github.com/markqvist/lxmf>Ta5d6ff`_, another project built with Reticulum.

Tc9d1d9Develop a Program with Reticulum

Tc9d1d9===========================================

If you want to develop programs that use Reticulum, the easiest way to get

started is to install the latest release of Reticulum via pip:

Tb4b4b4.. Tff7b72codeTb4b4b4::

pip3 install rns

The above command will install Reticulum and dependencies, and you will be

ready to import and use RNS in your own programs. The next step will most

likely be to look at some Te6edf3:ref:Te6edf3`Example Programs<examples-main>`.

Further information can be found in the Te6edf3:ref:Te6edf3`API Reference<api-main>`.

Tc9d1d9Participate in Reticulum Development

Tc9d1d9==============================================

If you want to participate in the development of Reticulum and associated

utilities, you'll want to get the latest source from GitHub. In that case,

don't use pip, but try this recipe:

Tb4b4b4.. Tff7b72codeTb4b4b4::

# Install dependencies

pip3 install cryptography pyserial

# Clone repository

git clone https://github.com/markqvist/Reticulum.git

# Move into Reticulum folder and symlink library to examples folder

cd Reticulum

ln -s ../RNS ./Examples/

# Run an example

python3 Examples/Echo.py -s

# Unless you've manually created a config file, Reticulum will do so now,

# and immediately exit. Make any necessary changes to the file:

nano ~/.reticulum/config

# ... and launch the example again.

python3 Examples/Echo.py -s

# You can now repeat the process on another computer,

# and run the same example with -h to get command line options.

python3 Examples/Echo.py -h

# Run the example in client mode to "ping" the server.

# Replace the hash below with the actual destination hash of your server.

python3 Examples/Echo.py 3e12fc71692f8ec47bc5

# Have a look at another example

python3 Examples/Filetransfer.py -h

When you have experimented with the basic examples, it's time to go read the

Te6edf3:ref:Te6edf3`Understanding Reticulum<understanding-main>` chapter.